home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / afreq301.zip / AUTOFREQ.DOC < prev    next >
Text File  |  1992-08-25  |  20KB  |  378 lines

  1.                  ╔══════════╗
  2.                  ║          ║
  3.                  ║ AUTOFREQ ║
  4.                  ║          ║
  5.                  ╚══════════╝
  6.  
  7. AUTOFREQ- A utility to allow SLBBS sysops to allow their users to request 
  8. files for FREQ, and to automatically request those files using your mailer 
  9. software.
  10.  
  11. Program Information
  12. ===================
  13. Program: AUTOFREQ
  14. Version: 3.0
  15. Author: Russell Steinthal
  16. Archive: AFREQ30.*
  17.  
  18.  
  19. Installation
  20. ============
  21. To install AutoFREQ:
  22.      1. Unarchive the distribution archive containing AutoFREQ into its own 
  23. subdirectory.
  24.      2. Run AFSETUP.EXE.  Explanation of that program follows.
  25.      3. Optionally, customize the message sent to users to notify them of the
  26. arrival of a requested file.  A sample message is included in the archive as 
  27. NOTIFY.TXT.
  28.      4. Add AutoFREQ to your doors menu.  AutoFREQ makes all of its writes to
  29. the BIOS, and requires that they be redirected to the modem by the BBS 
  30. software.
  31.  
  32. AFSETUP
  33. =======
  34. The first section of AFSETUP prompts you for some basic configuration 
  35. information about your system. (Note: For all prompts in this section, specify 
  36. COMPLETE paths to all files, or AutoFREQ may not function correctly.)
  37.      1. Batch file to write commands to: This is the path and filename of a 
  38. batch file to which AutoFREQ will output commands to request files.  These 
  39. commands will be configured later on in the program.  This batch file, when 
  40. run, will actually request files from other nodes, if the commands are
  41. configured correctly.
  42.      2. AutoFREQ log file: This is the path and filename to a text file in 
  43. which AutoFREQ will log all requests.  This file will be created and expanded 
  44. dynamically by AutoFREQ, and should not have the same path and filename as an 
  45. existing file, as any existing file of this name will be overwritten by 
  46. AutoFREQ.
  47.      3. Path and filename to write filenames and descriptions to: This is a 
  48. file to which AutoFREQ will write the filenames and descriptions of the files 
  49. that are requested and received.  It is the sysop's responsibility to call a
  50. file importer(such as F2DIRM by Wayne Robinson, which is included with
  51. AutoFREQ) with this file in order to import the received files into the file 
  52. database. The same note about overwriting existing files applies as with the 
  53. previous prompt.
  54.      4. Path to move received files TO: This is the path where you want 
  55. AutoFREQ to move files which have been requested and which have arrived to.  
  56. (Note: The final \ on the path must be present in order for AutoFREQ to 
  57. function correctly.)
  58.      5. Path to move received files FROM: This is the path where your mailer 
  59. software will place files that it has requested and which have arrived.  
  60. AutoFREQ moves files from this path to the path specified in the previous 
  61. selection. (Note: The final \ on the path must be present for AutoFREQ to 
  62. function correctly.)
  63.      6. Your BBS name: This is very easy, limit 100 characters.
  64.      7. Security level necessary to access sysop functions: There are several 
  65. functions available in AutoFREQ for sysops.  This is where you specify the 
  66. security level that a user needs to be able to access these functions.  It is
  67. recommended that you set this selection to the level of the sysop account on 
  68. your system, and possibly the level of the co-sysop(s).  WARNING: Setting this 
  69. level to the level of a normal user will seriously compromise the security 
  70. functions of AutoFREQ!
  71.  
  72. The second portion of AFSETUP is where you specify information about the nodes 
  73. that you want users to be able to request from.  One of the primary security 
  74. features of AutoFREQ is the fact that users can only request from nodes which 
  75. you have specified, and provided the file list for. You must supply the master 
  76. file list for all nodes that you want the user's to have access to.  (The 
  77. exception to this is the Blind Request function in the Sysop Options menu.)
  78. AFSETUP prompts you for the following information:
  79.      1. Name of node: This is easy- the name of the node you are specifying.
  80.      2. Node number: This is the network node number of this node.  This must 
  81. be accurate for AutoFREQ to function.
  82.      3. Master file list: This is the path and filename of the file which 
  83. contains the master list of files available on the node.
  84.      4. Minimum security level to access this node: This is the security level 
  85. a user needs to access this node.
  86.  
  87. After this, AFSETUP asks if you want to enter another node.  If you answer 
  88. yes, it repeats the procedure from step 1 above.  If your answer is no, it
  89. continues to the next stage of the installation.
  90.  
  91. In the next portion of the installation procedure, AFSETUP prompts you for 
  92. information on the request limits you want to specify.  Simply specify each 
  93. security level that users possess, and specify that level's maximum files and 
  94. bytes to allow.  Enter 0 for maximum bytes or files to indicate no limit on 
  95. that field.  For more information, see the section "Request Limits" later in 
  96. this documentaion.
  97.  
  98. The next section involves the actual commands used by AutoFREQ in requesting 
  99. files.  You are asked to input the command format for requesting files.  If 
  100. you are using XRobot or a similar utility, you should specify the syntax for
  101. calling that utility here.  If the syntax requires the name of the file, 
  102. specify <F>, and if it requires the node number to request from, specify <N>.
  103.  
  104. Following this, AFSETUP asks you for the commands which precede all requests 
  105. in the batch file.  These commands should execute whatever directory changes, 
  106. etc. that need to be performed prior to requesting files.  Enter a blank line
  107. to end input.
  108.  
  109. The final option that needs to be set is the prefix commands for the 
  110. notification batch file.  These commands are executed before mail notification 
  111. is sent to users, and should change to the directory containing the message 
  112. files, etc.  Follow the same instructions as the previous choice for entering
  113. this information.
  114.  
  115. Command Syntax for calling AutoFREQ
  116. ===================================
  117. AUTOFREQ <user's first name> <user's last name> <sec. level>
  118.  
  119. or to enter maintanance mode,
  120.  
  121. AUTOFREQ /MAINT
  122.  
  123. Operation of AutoFREQ
  124. =====================
  125. This section details how to use AutoFREQ in its user, or non-maintanance mode.
  126. When the program starts, it displays a menu of nodes available.  The user
  127. selects a node from the list to request from by specifying the number that
  128. appears next to the name of the node.  From here, AutoFREQ moves to the main 
  129. menu.
  130.  
  131. Main Menu
  132. =========
  133. The main menu has 4 options, with a 5th present if the user has sysop access.
  134. The options are explained below:
  135.     
  136. [L]ist files available
  137. ----------------------
  138. This presents the user with a list of all files available on this node.  It 
  139. takes this information from the master file list you provided for this node.
  140. After each screen of information, the output pauses, and prompts the user 
  141. to ask if he or she wants more.  Answering N returns the user to the main
  142. menu, and any other key gives the user the next screenful of files.
  143.  
  144. [R]equest file
  145. --------------
  146. This prompts the user for the name of the file to request. The filename the
  147. user inputs must exactly match one of the filenames in the master file list
  148. for the node that the user is requesting from.  If the file is not on the
  149. master file list, AutoFREQ responds, "File <filename> was not found." and 
  150. returns to the main menu.  If the file is found, AutoFREQ checks to see if the
  151. file has already been requested.  If it has, AutoFREQ outputs a message and
  152. asks the user if he or she wants to be notified when the file arrives.  For 
  153. more information on this, see the section "Mail Notification" later in this
  154. file.  If the file has not already been requested, AutoFREQ checks whether
  155. requesting this file would put the user over his/her security level's request
  156. limits. (See "Request Limits" later in this file)  After all of these checks,
  157. AutoFREQ outputs a message saying the file has been requested, and waits for
  158. the user to press a key.  After this, the user is returned to the main menu.
  159.  
  160. [S]elect node to request from
  161. -----------------------------
  162. This option allows the user to change the node to request from.  This returns
  163. the user to the menu of nodes that was displayed when AutoFREQ was started.
  164.  
  165. [E]xit AutoFREQ
  166. ---------------
  167. This doesn't need much explanation...
  168.  
  169. [A]ccess sysop functions
  170. ------------------------
  171. This option is present only when the user has sysop access, as specified in
  172. AUTOFREQ.CFG.  Selecting this option brings up a sub-menu containing the
  173. following options:
  174.  
  175. [V]iew a user's record: This allows the sysop to view any user's total files 
  176. and bytes requested, as well as the number of files and bytes requested since
  177. request limits were last reset.   At the name prompt, entering "QUIT" 
  178. returns the user to the previous menu, and "?" brings up a list of users.
  179. After a user's record has been displayed, pressing [R] resets that user's 
  180. request limits.  Any other key returns you to the name prompt.
  181.  
  182. [N]ode Maintenance: This option brings up another sub-menu containing the 
  183. following options:
  184.     1. [V]iew/edit node information: This displays a list of the nodes
  185.        available, and prompts for a number.  The information for that
  186.        node is then displayed.  The sysop can change any of this
  187.        information by choosing an option from the menu on the screen.  
  188.        Selecting "5" saves the changes and returns the user to the sysop 
  189.        options menu.
  190.     2. [A]dd a new node: This allows the sysop to add one or more new
  191.        nodes.  The procedure is the same as the procedure for specifying
  192.        node information in AFSETUP.
  193.     3. [D]elete a node: This displays a menu of available nodes, similar
  194.        to the menu displayed by the [V]iew/edit node command.  The user
  195.        selects a node, and after confirmation, AutoFREQ deletes that node
  196.        from the list of available nodes.
  197.     4. [E]xit to the previous menu: Returns the user to the sysop options
  198.        menu.
  199.  
  200. [R]equest a file from a node: This command allows the user to specify a 
  201. "blind" request, a request from ANY node, not necessarily one of the nodes
  202. that are setup in AutoFREQ.  The user is prompted first for the node, and then
  203. for the filename to request.  Pressing enter at either prompt aborts the
  204. process.  After the node and filename have been entered, AutoFREQ prompts for
  205. confirmation.  If the selections are confirmed, AutoFREQ requests that file.
  206.  
  207. [E]xit to the previous menu: Exits to the previous menu.
  208.  
  209. Magic Filenames
  210. ===============
  211. On some systems, files are made available for FREQ using "magic filenames".
  212. These are filenames which can be requested which are not the actual DOS
  213. filenames of the files they represent.  AutoFREQ only partially supports
  214. magic filenames.  If the sysop using the blind request feature requests
  215. a magic filename, AutoFREQ will correctly handle that request.  However,
  216. AutoFREQ has no way of knowing its actual filename, and when the file arrives,
  217. AutoFREQ will not know it has arrived.  This means that AUTOFREQ /MAINT will
  218. not perform its usual actions on that file.  The command that requested the
  219. file will not be removed from the batch file, and if the file had been
  220. requested using the normal main menu [R]equest function, the file's
  221. description will not be imported into the BBS file directory.  The fact that
  222. the command is not removed from the batch file results in that file being
  223. continually requested if the command is not removed manually.   This problem
  224. will not occur if the system is set to delete the command batch file during
  225. its daily maintenance.  (The sample batch file provided later on in this file
  226. implements the daily deletion of the batch file.)
  227.  
  228. Request Limits
  229. ==============
  230. One of the ways in which AutoFREQ provides security is in the request limits
  231. function.  This allows sysops to limit the number of files and bytes a user
  232. can request.  The information is kept in the file LIMITS.LST.  The format of
  233. this file is: <security level> <max files> <max bytes>.  A maximum of 0
  234. indicates no limit.  If a user possesses a security level which is not
  235. present in LIMITS.LST, AutoFREQ imposes no limits on that user.  When a user
  236. has reached the limit in bytes or files, AutoFREQ does not allow that user
  237. to request any more files.  The user is not able to request additional files
  238. until his/her limit is reset.  There are 2 ways of doing this:
  239.     1. A sysop can reset an individual user's limits by viewing the
  240. user's record, and then pressing "R".
  241.     2. To reset all users' limits, the sysop needs only to delete the
  242. file LIMITS.USR from the AutoFREQ directory.  This file will be recreated by
  243. AutoFREQ the next time a user requests a file.
  244. The second method of resetting limits can be used by the sysop to set daily,
  245. weekly, monthly, etc. limits.  For example, to set weekly limits, the sysop
  246. needs to configure an event to run every seven days, and have that event
  247. delete LIMITS.USR.  To set daily limits, simply delete LIMITS.USR every day.
  248.  
  249. Maintenance Mode
  250. ================
  251. When invoked with the /MAINT command line switch, AutoFREQ enters the
  252. maintenance mode.  When in this mode, AutoFREQ does not display any user
  253. interface.  Instead, it performs all of the necessary file importing and
  254. related operations.  AutoFREQ checks its list of requested files, and if it
  255. finds any of the files on that list in the directory specified as the "move
  256. from" directory in AUTOFREQ.CFG, it moves those files to the "move to"
  257. directory.  It then accesses the master file list for the node that provided
  258. the file, and extracts the description.  It then writes the filename and
  259. description to the text file specified in AUTOFREQ.CFG.  AutoFREQ then deletes
  260. the command that requested that file from the command batch file, and then
  261. it sends mail notification to all users who are on the notification list for
  262. that file.  Finally, AutoFREQ processes all files which had been "blind"
  263. requested, and terminates.  Under normal circumstances, AutoFREQ outputs to
  264. the screen only its copyright notice during this process.
  265.  
  266. Mail Notification
  267. =================
  268. When a file which has been requested arrives, AutoFREQ sends a message in the
  269. BBS mail system to the user(s) that requested the file to notify them that
  270. the file has arrived.  The text of the message is configurable by the sysop,
  271. and is stored in the file NOTIFY.TXT.  This file must be present in the same
  272. directory as AutoFREQ.  To allow sysops to define messages, certain codes are
  273. active in the message text.  When AutoFREQ reads the message text and finds
  274. one of those codes embedded in the text, it replaces the code with the
  275. correct string.  The codes are as follows:
  276. <N>     Node number requested from
  277. <NN>    Node requested from's name
  278. <F>     Filename requested
  279. <FN>    User's first name
  280. <LN>    User's last name
  281. <D>     Description of the file
  282.  
  283. To send the mail notification messages, AutoFREQ invokes the SLMAIL utility
  284. which comes with SLBBS.  AutoFREQ invokes SLMAIL by means of a batch file,
  285. and the commands which are specified during the execution of AFSETUP are
  286. executed prior to executing SLMAIL.  These commands are stored in the file
  287. NOTIFY.PRE.
  288.  
  289. Batch Files
  290. ===========
  291. AutoFREQ, and for that matter most BBS software and utilities, requires
  292. batch files to operate properly.  With a good set of batch files, AutoFREQ
  293. will seamlessly interface with mailer and BBS software to completly automate
  294. file requesting.  The following is a sample batch file for use with
  295. AutoFREQ, FrontDoor, and SLBBS.  The author of AutoFREQ makes no warantee
  296. concerning the effectiveness of this batch file, it is provided as a sample
  297. only. (Thank you to Jim Malkowski, sysop of The Final Frontier BBS-  
  298. The official AutoFREQ Support BBS and distribution site!  201-387-9510,
  299. for the use of his batch file.)            
  300.  
  301. rem Change to the directory containing AutoFREQ
  302. cd\autofreq
  303. autofreq /maint
  304. rem Change to the directory to which AutoFREQ moved the files
  305. cd\slbbs\files\freqs
  306. rem Run F2DIRM, a file importer.
  307. f2dirm requests c:\utilitie\dirmaint.exe c:\slbbs\files.bbs /D /R
  308. cd\slbbs
  309. rem Delete the batch file that AutoFREQ wrote commands to.  You do this if
  310. rem you don't want to request files the next day that didn't arrive the
  311. rem first day.
  312. del nitefreq.bat
  313. cd\slbbs
  314.  
  315. Registration
  316. ============
  317. AutoFREQ is shareware.  You are free to use AutoFREQ for an evaluation period
  318. of 2 weeks.  If, at the end of that time, you continue to use AutoFREQ, you
  319. are required to register the software.  The registration fee for AutoFREQ is
  320. $5, and entitles the user to free upgrades and notification of all bugs
  321. (hopefully none) which are found in AutoFREQ.  Registering also removes the
  322. unregistered message in the main menu screen, and the message and time delay
  323. on exit of the program.  To register AutoFREQ follow the instructions in
  324. the file REGISTER.TXT.
  325.  
  326. License
  327. =======
  328. AutoFREQ is shareware. It is not free.  You are free to use AutoFREQ for an
  329. evaluation period of two weeks.  After that, if you continue to use AutoFREQ, you are required to register it.  You may freely copy and distribute AutoFREQ, provided that you always distribute the ENTIRE archive. You may not charge any fee for AutoFREQ, except for a nominal charge to cover the cost of disks.  If you are distributing AutoFREQ for any charge other than for postage, you must notify the author.  Under no circumstances 
  330. is the author's copyright to be removed from the program.  Decompiling and other reverse engineering of AutoFREQ is prohibited.  The registration key for AutoFREQ that users receive with registration is never to be distributed.  At no point does the author lose his copyright on the software, and the author retains at all times the right to limit the distribution and use of AutoFREQ.
  331.  
  332. Comments, Questions, etc.
  333. =========================
  334. If you have any comments, questions, complaints, bug reports, or suggestions
  335. about AutoFREQ, please feel free to contact the author, who can be contacted
  336. at any of the following addresses:
  337.         U.S. Mail: Russell Steinthal
  338.                366 Whitman Street
  339.                            Haworth, N.J. 07641
  340.  
  341. On the Final Frontier BBS: Fidonet: 1:2604/206
  342.                 SL-Net: 250:104/1227
  343.                  Phone: (201) 387-9510
  344.  
  345. (On the Final Frontier BBS the author can be mailed as RUSSELL STEINTHAL,
  346.  and there is a message subboard setup for support of AutoFREQ)
  347.  
  348. The Final Frontier BBS is the official support and distribution site for
  349. AutoFREQ.  The latest version of AutoFREQ will always be available on the
  350. Final Frontier BBS. Contact Jim Malkowski of DCS<Data Communications Systems,
  351. on the Final Frontier BBS to order AutoFREQ On-Line, and also browse through
  352. our verbose product listings of which you may also buy ON-LINE, by this author 
  353. and many others....Call Today!
  354.  
  355. Copyrights
  356. ==========
  357. The following are copyrights of other authors, which were used in this file:
  358.     F2DIRM is a utility by Wayne Robinson, sysop of the Quantum Zone,
  359. Fidonet 1:2604/0.
  360.     SLMAIL is a utility which comes with Searchlight BBS software, and
  361. is copyrighted by Frank Larosa and Searchlight Software.
  362.     SLBBS (Searchlight Bulletin Board System) is copyright Frank Larosa
  363. and Searchlight software.
  364.     XROBOT is copyright Joaquim H. Homrighausen.
  365.         FROntDOor is copyrighted by Advanced Engineering sarl, and Joaquim H.
  366. Homrighausen.
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.